Schema bimoL.v1
Schema bimoL.v1 : Typ złożony GetPaymentSummonList
Typ złożony GetPaymentSummonList
Opis
Dane zamówionej listy wezwań do zapłaty
Typ pozwalający na przekazanie danych w celu udostępnienia listy zleconych wezwań do zapłaty
Przestrzeń nazw http://api.big.pl/bimoL/v1
Diagram
Element sentDateCriterion Element orderDateCriterion Element shipmentNumber Element proxyClientId Element status Element debtorName Grupa bc:objectId Sequence Typ złożony GetPaymentSummonList
Przegląd
GetPaymentSummonList
Dane zamówionej listy wezwań do zapłaty
Typ pozwalający na przekazanie danych w celu udostępnienia listy zleconych wezwań do zapłaty
limit optional xs:int
Maksymalna liczba rekordów w odpowiedzi.
start optional xs:int
Numer porządkowy pierwszego rekordu, który ma się znaleźć w odpowiedzi.
counting optional xs:boolean
Wartość "prawda" oznacza, że odpowiedź ma zawierać liczbę wszystkich odnalezionych zleceń spełniających kryteria filtrowania.
ordersScope optional Typ prosty ordersScopeEnum
Zbiór zleceń zwracanych na liście
Deklaracja zakresu zleconych wysyłek zwracanych na liście. Jeżeli atrybut nie zostanie zadeklarowany to zbiór będzie zawężony do wysyłek zleconych we własnym imieniu
Powiązane reguły walidacji:

Identyfikator Opis
RDPS05 Brak konfiguracji szablonu dedykowanego dla wskazanego rodzaju zobowiązania. Konfigurację szblonu należy wykonać w profilu klienta w systemie biznes.big.pl
Sequence
bc:objectId optional
Grupa umożliwiająca przekazanie unikalnego identyfikatora obiektu w rejestrze BIG InfoMonitor i / lub unikalnego identyfikatora obiektu w rejestrze zewnętrznym (np. subskrybenta).
debtorName optional Typ prosty string250
Nazwa dłużnika
Wyszukanie na podstawie fragmentu nazwy dłużnika
status optional Typ prosty paymentSummonOrderStatusEnum
Status zlecenia wysyłki
Aktualny status zlecenia wysyłki
proxyClientId optional Typ prosty id
Identyfikator klienta w imieniu którego zlecono wysyłkę
Zawężenie listy do wysyłek zleconych w imieniu wskazanego subskrybenta. Wartość nie może być przekazana, jeżeli zakres zamawianej listy nie obejmuje wysyłek zleconych w imieniu innych klientów BIG
shipmentNumber optional Typ prosty string32
Numer nadania wysyłki
Numer nadania wysyłki listu z wezwaniem do zapłaty, który został nadany przez pocztę
orderDateCriterion optional Typ złożony DateCriterion
Data zlecenia wysyłki
Zawężenie listy wysyłek na podstawie okresu ich zlecenia do BIG InfoMonitor
initialDate optional xs:date
Data początku okresu
finalDate optional xs:date
Data końcowa przedziału czasu
sentDateCriterion optional Typ złożony DateCriterion
Data wysyłki wezwania
Zawężenie listy wysyłek na podstawie okresu w którym potwierdzono ich realizację
initialDate optional xs:date
Data początku okresu
finalDate optional xs:date
Data końcowa przedziału czasu
Używany przez
Atrybuty
NazwaTypUżywaDomyślnieStałyOpis
limitxs:intoptional20 
Maksymalna liczba rekordów w odpowiedzi.
startxs:intoptional1 
Numer porządkowy pierwszego rekordu, który ma się znaleźć w odpowiedzi.
countingxs:booleanoptionalfalse 
Wartość "prawda" oznacza, że odpowiedź ma zawierać liczbę wszystkich odnalezionych zleceń spełniających kryteria filtrowania.
ordersScopeTyp prosty ordersScopeEnum optionalselfOrders 
Zbiór zleceń zwracanych na liście
Deklaracja zakresu zleconych wysyłek zwracanych na liście. Jeżeli atrybut nie zostanie zadeklarowany to zbiór będzie zawężony do wysyłek zleconych we własnym imieniu
Powiązane reguły walidacji:

Identyfikator Opis
RDPS05 Brak konfiguracji szablonu dedykowanego dla wskazanego rodzaju zobowiązania. Konfigurację szblonu należy wykonać w profilu klienta w systemie biznes.big.pl
Źródło
<xs:complexType name="GetPaymentSummonList" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:documentation>
      <div class="nazwa pl-PL" xmlns="http://www.w3.org/1999/xhtml">Dane zamówionej listy wezwań do zapłaty</div>
      <div class="opis pl-PL" xmlns="http://www.w3.org/1999/xhtml">Typ pozwalający na przekazanie danych w celu udostępnienia listy zleconych wezwań do zapłaty</div>
    </xs:documentation>
  </xs:annotation>
  <xs:sequence>
    <xs:group ref="bc:objectId" minOccurs="0" />
    <xs:element name="debtorName" type="bc:string250" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <div class="nazwa pl-PL" xmlns="http://www.w3.org/1999/xhtml">Nazwa dłużnika</div>
          <div class="opis pl-PL" xmlns="http://www.w3.org/1999/xhtml">Wyszukanie na podstawie fragmentu nazwy dłużnika</div>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="status" type="bl:paymentSummonOrderStatusEnum" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <div class="nazwa pl-PL" xmlns="http://www.w3.org/1999/xhtml">Status zlecenia wysyłki</div>
          <div class="opis pl-PL" xmlns="http://www.w3.org/1999/xhtml">Aktualny status zlecenia wysyłki</div>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="proxyClientId" type="bc:id" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <div class="nazwa pl-PL" xmlns="http://www.w3.org/1999/xhtml">Identyfikator klienta w imieniu którego zlecono wysyłkę</div>
          <div class="opis pl-PL" xmlns="http://www.w3.org/1999/xhtml">Zawężenie listy do wysyłek zleconych w imieniu wskazanego subskrybenta. Wartość nie może być przekazana, jeżeli zakres zamawianej listy nie obejmuje wysyłek zleconych w imieniu innych klientów BIG</div>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="shipmentNumber" type="bc:string32" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <div class="nazwa pl-PL" xmlns="http://www.w3.org/1999/xhtml">Numer nadania wysyłki</div>
          <div class="opis pl-PL" xmlns="http://www.w3.org/1999/xhtml">Numer nadania wysyłki listu z wezwaniem do zapłaty, który został nadany przez pocztę</div>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="orderDateCriterion" type="bc:DateCriterion" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <div class="nazwa pl-PL" xmlns="http://www.w3.org/1999/xhtml">Data zlecenia wysyłki</div>
          <div class="opis pl-PL" xmlns="http://www.w3.org/1999/xhtml">Zawężenie listy wysyłek na podstawie okresu ich zlecenia do BIG InfoMonitor</div>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="sentDateCriterion" type="bc:DateCriterion" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <div class="nazwa pl-PL" xmlns="http://www.w3.org/1999/xhtml">Data wysyłki wezwania</div>
          <div class="opis pl-PL" xmlns="http://www.w3.org/1999/xhtml">Zawężenie listy wysyłek na podstawie okresu w którym potwierdzono ich realizację</div>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
  </xs:sequence>
  <xs:attribute name="limit" type="xs:int" default="20">
    <xs:annotation>
      <xs:documentation>
        <div class="opis pl-PL" xmlns="http://www.w3.org/1999/xhtml">Maksymalna liczba rekordów w odpowiedzi.
          </div>
      </xs:documentation>
    </xs:annotation>
  </xs:attribute>
  <xs:attribute name="start" type="xs:int" default="1">
    <xs:annotation>
      <xs:documentation>
        <div class="opis pl-PL" xmlns="http://www.w3.org/1999/xhtml">Numer porządkowy pierwszego rekordu, który ma się znaleźć w odpowiedzi.
          </div>
      </xs:documentation>
    </xs:annotation>
  </xs:attribute>
  <xs:attribute name="counting" type="xs:boolean" default="false">
    <xs:annotation>
      <xs:documentation>
        <div class="opis pl-PL" xmlns="http://www.w3.org/1999/xhtml">Wartość "prawda" oznacza, że odpowiedź ma zawierać liczbę wszystkich odnalezionych zleceń spełniających kryteria filtrowania.
          </div>
      </xs:documentation>
    </xs:annotation>
  </xs:attribute>
  <xs:attribute name="ordersScope" type="bl:ordersScopeEnum" default="selfOrders">
    <xs:annotation>
      <xs:documentation>
        <div class="nazwa pl-PL" xmlns="http://www.w3.org/1999/xhtml">Zbiór zleceń zwracanych na liście</div>
        <div class="opis pl-PL" xmlns="http://www.w3.org/1999/xhtml">Deklaracja zakresu zleconych wysyłek zwracanych na liście. Jeżeli atrybut nie zostanie zadeklarowany to zbiór będzie zawężony do wysyłek zleconych we własnym imieniu</div>
        <div class="reguly pl-PL" xmlns="http://www.w3.org/1999/xhtml">
          <div class="reguly-tytul pl-PL">Powiązane reguły walidacji:</div>
          <br />
          <table class="zestaw-regul">
            <tr>
              <th>Identyfikator</th>
              <th>Opis</th>
            </tr>
            <tr>
              <td>
                <a class="regula pl-PL" href="Economic%20informations%20online%20rules.html#RDPS05">RDPS05</a>
              </td>
              <td>Brak konfiguracji szablonu dedykowanego dla wskazanego rodzaju zobowiązania. Konfigurację szblonu należy wykonać w profilu klienta w systemie biznes.big.pl</td>
            </tr>
          </table>
        </div>
      </xs:documentation>
    </xs:annotation>
  </xs:attribute>
</xs:complexType>
Zobacz także